SFXCallback

Class to deal with a callback function.

#include <SFXCallback.h.hpp>

class SFXCallback;

SFMTYPEDEFCLASS(SFXCallback)

Description

The SFXCallback class is used to set or get the parameters of a callback function, or check its registration status.

Reference

SFXTask | SFXTimer

Member

Constructor/Destructor
SFXCallback( `Void` ) Constructor of SFXCallback class.
~SFXCallback( `Void` ) Destructor of　SFXCallback ｃlass.

Public Functions
`Void`	Cancel( `Void` ) Cancel the callback function.
static `SFXCallbackConstRef`	EmptyInstance( `Void` ) Get an empty instance of the SFXCallback class.
`CallbackSPP`	GetProcedure( `Void` ) Get the callback function to be set.
`VoidPtr`	GetReference( `Void` ) Get the user data to be set.
`Bool`	IsQueued( `Void` ) Check whether the callback function is registered or not.
`Void`	Set( `CallbackSPP` spp , `VoidPtr` reference ) Set the necessary information regarding a callback.
`AEECallback *`	interface_cast( `SFXCallback *` param ) Convert SFXCallback into AEECallback.
`AEECallback const *`	interface_cast( `SFXCallback const *` param ) Convert SFXCallback into AEECallback.

Types
CallbackSPP Type of the callback function.

Global Functions
`AEECallback *`	interface_cast( `SFXCallback *` param ) Convert SFXCallback into AEECallback.
`AEECallback const *`	interface_cast( `SFXCallback const *` param ) Convert SFXCallback into AEECallback.

SFXCallback::SFXCallback

Constructor of SFXCallback class.

[ public, explicit ]
SFXCallback(Void);

SFXCallback::~SFXCallback

Destructor of　SFXCallback ｃlass.

[ public ]
~SFXCallback(Void);

Description

Registered callback function is canceled in the destructor.

Reference

SFXCallback::Cancel

SFXCallback::Cancel

Cancel the callback function.

[ public ]
Void Cancel(Void);

Description

If no callback function is registered, nothing happens.

Reference

SFXCallback::Set

SFXCallback::EmptyInstance

Get an empty instance of the SFXCallback class.

[ public, static ]
SFXCallbackConstRef EmptyInstance(Void);

Description

Get an instance that represents an empty callback.

SFXCallback::GetProcedure

Get the callback function to be set.

[ public, const ]
CallbackSPP GetProcedure(Void);

Return value

Return the set callback function.

Reference

SFXCallback::GetReference | SFXCallback::Set

SFXCallback::GetReference

Get the user data to be set.

[ public, const ]
VoidPtr GetReference(Void);

Return value

Return the set user data.

Reference

SFXCallback::GetReference | SFXCallback::Set

SFXCallback::IsQueued

Check whether the callback function is registered or not.

[ public, const ]
Bool IsQueued(Void);

Return value

If registered : true
Otherwise : false

SFXCallback::Set

Set the necessary information regarding a callback.

[ public ]
Void Set(
    CallbackSPP spp     // callback function
    VoidPtr reference   // user data
);

Reference

SFXCallback::GetProcedure | SFXCallback::GetReference

interface_cast

Convert SFXCallback into AEECallback.

[ public, friend ]
AEECallback * interface_cast(
    SFXCallback * param   // callback to cast
);

[ public, friend ]
AEECallback const * interface_cast(
    SFXCallback const * param   // callback to cast
);

SFXCallback::CallbackSPP

Type of the callback function.

typedef Void(* SFXCallback::CallbackSPP)(VoidPtr reference)