SophiaFramework UNIVERSE 5.3 |
#include <SFXEventRange.h.hpp>
class SFXEventRange;
<link linkend="sec.macro.core.typedef.SFMTYPEDEFCLASS">SFMTYPEDEFCLASS</link>(SFXEventRange)
The SFXEventRange class represents an event range necessary to register an event handler or a tracer which is used in SFY GUI framework.
The event range is specified with the event type( BREW API AEEEvent type) and the P16 parameter(UInt16 type) for each of the starting event and the ending event.
For instance, SFXEventRange(sEventType,eEventType, sP16, eP16) represents events in the range between the (sEventType, sP16, *) event and (eEventType, eP16, *) event.
Example 817. Method to use the SFXEventRange class (1): registering an event handler
// constructor
HelloWorld::HelloWorld(Void) static_throws
{
if (static_try()) {
static_throw(RegisterHandler(
SFXEventRange(SFEVT_RESPONDER_RENDER, SFEVT_RESPONDER_RENDER,
SFP16_RENDER_REQUEST, SFP16_RENDER_REQUEST),
XANDLER_INTERNAL(OnRenderRequest)
));
}
if (static_try()) {
static_throw(RegisterHandler(
SFXEventRange(SFEVT_KEY, SFEVT_KEY, SFP16_BEGIN, SFP16_END),
XANDLER_INTERNAL(OnKey)
));
}
}
Example 818. Method to use the SFXEventRange class (2): registering an event handler
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));
Example 819. Method to use the SFXEventRange class (3): registering a tracer
static SFXEventRange::AtomRecConst range[] = { { SFEVT_APP_START, SFEVT_APP_START, SFP16_BEGIN, SFP16_END}, { SFEVT_APP_STOP, SFEVT_APP_STOP, SFP16_BEGIN, SFP16_END}, { SFEVT_APP_RESUME, SFEVT_APP_RESUME, SFP16_BEGIN, SFP16_END}, { SFEVT_APP_SUSPEND, SFEVT_APP_SUSPEND, SFP16_BEGIN, SFP16_END} }; static SFYTracer::RuleRecConst rule[lengthof(range)] = { { SFYTracer::ORDER_BACKWARD, SFYTracer::STATE_ALL, true}, { SFYTracer::ORDER_FORWARD, SFYTracer::STATE_ALL, true}, { SFYTracer::ORDER_BACKWARD, SFYTracer::STATE_ALL, true}, { SFYTracer::ORDER_FORWARD, SFYTracer::STATE_ALL, true} }; SFCError error; error = RegisterTracer(atomic_cast(range), rule, lengthof(range));
SFXEvent | SFCEventEnum | SFYResponder::RegisterHandler | SFYResponder::RegisterTracer | BREW API AEEEvent
Constructor/Destructor |
---|
SFXEventRange( Void ) Constructor of the SFXEventRange class.
|
SFXEventRange(
SFXEventRangeConstRef param
) Constructor of the SFXEventRange class.
|
SFXEventRange(
AEEEvent stype
, AEEEvent etype
, UInt16 sp16
, UInt16 ep16
) Constructor of the SFXEventRange class.
|
Public Functions | |
---|---|
Bool |
Contains(
SFXEventRangeConstRef param
) Check whether or not this event range contains the specified event or event range.
|
Bool |
Contains(
SFXEventConstRef param
) Check whether or not this event range contains the specified event or event range.
|
Bool |
Contains(
AEEEvent stype
, AEEEvent etype
, UInt16 sp16
, UInt16 ep16
) Check whether or not this event range contains the specified event or event range.
|
Bool |
Contains(
AEEEvent type
, UInt16 p16
) Check whether or not this event range contains the specified event or event range.
|
Bool |
ContainsP16(
SFXEventRangeConstRef param
) Check whether or not this event range contains the P16 parameter of the specified event or event range.
|
Bool |
ContainsP16(
SFXEventConstRef param
) Check whether or not this event range contains the P16 parameter of the specified event or event range.
|
Bool |
ContainsP16(
UInt16 sp16
, UInt16 ep16
) Check whether or not this event range contains the P16 parameter of the specified event or event range.
|
Bool |
ContainsP16(
UInt16 p16
) Check whether or not this event range contains the P16 parameter of the specified event or event range.
|
Bool |
ContainsType(
SFXEventRangeConstRef param
) Check whether or not this event range contains the type of the specified event or event range.
|
Bool |
ContainsType(
SFXEventConstRef param
) Check whether or not this event range contains the type of the specified event or event range.
|
Bool |
ContainsType(
AEEEvent stype
, AEEEvent etype
) Check whether or not this event range contains the type of the specified event or event range.
|
Bool |
ContainsType(
AEEEvent type
) Check whether or not this event range contains the type of the specified event or event range.
|
static SFXEventRangeConstRef |
EmptyInstance( Void ) Get an empty event range.
|
Bool |
Equals(
SFXEventRangeConstRef param
) Check whether or not this event range equals the specified event range.
|
Bool |
Equals(
AEEEvent stype
, AEEEvent etype
, UInt16 sp16
, UInt16 ep16
) Check whether or not this event range equals the specified event range.
|
Bool |
EqualsP16(
SFXEventRangeConstRef param
) Check whether or not the P16 parameter range of this event range equals the specified P16 parameter range.
|
Bool |
EqualsP16(
UInt16 sp16
, UInt16 ep16
) Check whether or not the P16 parameter range of this event range equals the specified P16 parameter range.
|
UInt16 |
GetEndP16( Void ) Get the P16 parameter of the ending event of this event range.
|
AEEEvent |
GetEndType( Void ) Get the event type of the ending event of this event range.
|
UInt16 |
GetStartP16( Void ) Get the P16 parameter of the starting event of this event range.
|
AEEEvent |
GetStartType( Void ) Get the event type of the starting event of this event range.
|
Void |
Set(
SFXEventRangeConstRef param
) Set this event range to the specified range.
|
Void |
Set(
AEEEvent stype
, AEEEvent etype
, UInt16 sp16
, UInt16 ep16
) Set this event range to the specified range.
|
Void |
SetEndP16(
UInt16 param
) Set the P16 parameter of the ending event of this event range to the specified value.
|
Void |
SetEndType(
AEEEvent param
) Set the event of the ending event of this event range to the specified value.
|
Void |
SetP16(
UInt16 sp16
, UInt16 ep16
) Set the P16 parameter range of this event range to the specified range.
|
Void |
SetStartP16(
UInt16 param
) Set the P16 parameter of the starting event of this event range to the specified value.
|
Void |
SetStartType(
AEEEvent param
) Set the event type of the starting event of this event range to the specified value.
|
Void |
SetType(
AEEEvent stype
, AEEEvent etype
) Set the event type range of this event range to the specified range.
|
Bool |
operator!=(
SFXEventRangeConstRef left
, SFXEventRangeConstRef right
) Check the "!=" relation.
|
SFXEventRangeRef |
operator=(
SFXEventRangeConstRef param
) Assign the specified event range to this event range.
|
Bool |
operator==(
SFXEventRangeConstRef left
, SFXEventRangeConstRef right
) Check the "==" relation.
|
Bool |
(
SFXEventRangeConstRef param
) Check whether or not the event type range of this event range equals the specified event type range.
|
Bool |
(
AEEEvent stype
, AEEEvent etype
) Check whether or not the event type range of this event range equals the specified event type range.
|
SFXEventRange::AtomRec * |
atomic_cast(
SFXEventRange * param
) Convert SFXEventRange into SFXEventRange::AtomRec.
|
SFXEventRange::AtomRec const * |
atomic_cast(
SFXEventRange const * param
) Convert SFXEventRange into SFXEventRange::AtomRec.
|
Types |
---|
AtomRec
(inherits from SFXRectangle)
The SFXEventRange::AtomRec struct represents an event range.
|
Global Functions | |
---|---|
Bool |
(
SFXEventRangeConstRef param
) Check whether or not the event type range of this event range equals the specified event type range.
|
Bool |
(
AEEEvent stype
, AEEEvent etype
) Check whether or not the event type range of this event range equals the specified event type range.
|
SFXEventRange::AtomRec * |
atomic_cast(
SFXEventRange * param
) Convert SFXEventRange into SFXEventRange::AtomRec.
|
SFXEventRange::AtomRec const * |
atomic_cast(
SFXEventRange const * param
) Convert SFXEventRange into SFXEventRange::AtomRec.
|
[ public, explicit ] SFXEventRange(Void);
[ public ] SFXEventRange( SFXEventRangeConstRef param // event range );
[ public, explicit ] SFXEventRange( AEEEvent stype // type of starting event AEEEvent etype // type of ending event UInt16 sp16 // P16 parameter of starting event UInt16 ep16 // P16 parameter of ending event );
If the arguments are specified, this constructor will set this event by calling the SFXEventRange::Set function internally.
[ public, const ] Bool Contains( SFXEventRangeConstRef param // event range );
[ public, const ] Bool Contains( SFXEventConstRef param // event );
[ public, const ] Bool Contains( AEEEvent stype // type of starting event AEEEvent etype // type of ending event UInt16 sp16 // P16 parameter of starting event UInt16 ep16 // P16 parameter of ending event );
[ public, const ] Bool Contains( AEEEvent type // event type UInt16 p16 // P16 parameter );
... param の説明 ...
This function checks whether or not this event range contains the specified event or event range.
[ public, const ] Bool ContainsP16( SFXEventRangeConstRef param // event range );
[ public, const ] Bool ContainsP16( SFXEventConstRef param // event );
[ public, const ] Bool ContainsP16( UInt16 sp16 // P16 parameter of starting event UInt16 ep16 // P16 parameter of ending event );
[ public, const ] Bool ContainsP16( UInt16 p16 // P16 parameter );
This function checks whether or not this event range contains the P16 parameter of the specified event or event range.
SFXEventRange::Contains | SFXEventRange::ContainsType | SFXEvent
[ public, const ] Bool ContainsType( SFXEventRangeConstRef param // event range );
[ public, const ] Bool ContainsType( SFXEventConstRef param // event );
[ public, const ] Bool ContainsType( AEEEvent stype // type of starting event AEEEvent etype // type of ending event );
[ public, const ] Bool ContainsType( AEEEvent type // event type );
This function checks whether or not this event range contains the type of the specified event or event range.
SFXEventRange::Contains | SFXEventRange::ContainsP16 | SFXEvent
[ public, static ] SFXEventRangeConstRef EmptyInstance(Void);
Empty event range.
This function gets the empty event range that contains no events.
[ public, const ] Bool Equals( SFXEventRangeConstRef param // event range );
[ public, const ] Bool Equals( AEEEvent stype // type of starting event AEEEvent etype // type of ending event UInt16 sp16 // P16 parameter of starting event UInt16 ep16 // P16 parameter of ending event );
This function checks whether or not this event range equals the specified event range.
SFXEventRange::operator== | | SFXEventRange::EqualsP16 | SFXEvent | BREW API AEEEvent
[ public, const ] Bool EqualsP16( SFXEventRangeConstRef param // event range );
[ public, const ] Bool EqualsP16( UInt16 sp16 // P16 parameter of starting event UInt16 ep16 // P16 parameter of ending event );
This function checks whether or not the P16 parameter range of this event range equals the specified P16 parameter range.
[ public, const ] Bool EqualsType( SFXEventRangeConstRef param // event range );
[ public, const ] Bool EqualsType( AEEEvent stype // type of starting event AEEEvent etype // type of ending event );
This function checks whether or not the event type range of this event range equals the specified event type range.
SFXEventRange::Equals | SFXEventRange::EqualsP16 | SFXEvent | BREW API AEEEvent
[ public, const ] UInt16 GetEndP16(Void);
P16 parameter of the ending event of this event range.
This function gets the P16 parameter of the ending event of this event range.
SFXEventRange::SetEndP16 | SFXEventRange::Set | SFXEventRange::SetP16 | SFXEvent
[ public, const ] AEEEvent GetEndType(Void);
Event type of the ending event of this event range.
This function gets the event type of the ending event of this event range.
SFXEventRange::SetEndType | SFXEventRange::Set | SFXEventRange::SetType | SFXEvent | BREW API AEEEvent
[ public, const ] UInt16 GetStartP16(Void);
P16 parameter of the starting event of this event range.
This function gets the P16 parameter of the starting event of this event range.
[ public, const ] AEEEvent GetStartType(Void);
Event type of the starting event of this event range.
This function gets the event type of the starting event of this event range.
SFXEventRange::SetStartType | SFXEventRange::Set | SFXEvent | BREW API AEEEvent
[ public ] Void Set( SFXEventRangeConstRef param // event range );
[ public ] Void Set( AEEEvent stype // event type of the starting event AEEEvent etype // event type of the ending event UInt16 sp16 // P16 parameter of the starting event UInt16 ep16 // P16 parameter of the ending event );
This function sets this event range to the specified range.
SFXEventRange::GetStartType | SFXEventRange::GetStartP16 | SFXEventRange::GetEndType | SFXEventRange::GetEndP16 | SFXEventRange::SetStartType | SFXEventRange::SetStartP16 | SFXEventRange::SetEndType | SFXEventRange::SetEndP16 | SFXEventRange::SetType | SFXEventRange::SetP16 | SFXEvent | BREW API AEEEvent
This function sets the P16 parameter of the ending event of this event range to the specified value.
SFXEventRange::GetEndP16 | SFXEventRange::Set | SFXEventRange::SetP16 | SFXEvent
This function sets the event of the ending event of this event range to the specified value.
SFXEventRange::GetEndType | SFXEventRange::Set | SFXEventRange::SetType | SFXEvent | BREW API AEEEvent
[ public ] Void SetP16( UInt16 sp16 // P16 parameter of the starting event UInt16 ep16 // P16 parameter of the ending event );
This function sets the P16 parameter range of this event range to the specified range.
SFXEventRange::GetStartP16 | SFXEventRange::GetEndP16 | SFXEventRange::SetStartP16 | SFXEventRange::SetEndP16 | SFXEventRange::Set | SFXEventRange::SetType | SFXEvent
This function sets the P16 parameter of the starting event of this event range to the specified value.
This function sets the event type of the starting event of this event range to the specified value.
SFXEventRange::GetStartType | SFXEventRange::Set | SFXEvent | BREW API AEEEvent
[ public ] Void SetType( AEEEvent stype // event type of the starting event AEEEvent etype // event type of the ending event );
This function sets the event type range of this event range to the specified range.
SFXEventRange::GetStartType | SFXEventRange::GetEndType | SFXEventRange::SetStartType | SFXEventRange::SetEndType | SFXEventRange::Set | SFXEventRange::SetP16 | SFXEvent | BREW API AEEEvent
[ public, friend ] SFXEventRange::AtomRec * atomic_cast( SFXEventRange * param // event range to be casted );
[ public, friend ] SFXEventRange::AtomRec const * atomic_cast( SFXEventRange const * param // event range to be casted );
This function casts the SFXEventRange class into the SFXRectangle::AtomRec struct.
[ public ] SFXEventRangeRef operator=( SFXEventRangeConstRef param // event range );
[ public, friend ] Bool operator==( SFXEventRangeConstRef left // event range to be compared SFXEventRangeConstRef right // event range to compare with );
SFXEventRange::operator!= | SFXEventRange::Equals | SFXEvent
[ public, friend ] Bool operator!=( SFXEventRangeConstRef left // evant range to be compared SFXEventRangeConstRef right // event range to compare with );
SFXEventRange::operator!= | SFXEventRange::Equals | SFXEvent
struct AtomRec { SFMUTILITYATOMDECLARE(SFXEventRange) AEEEvent stype; // type of starting event AEEEvent etype; // type of ending event UInt16 sp16; // P16 parameter of starting event UInt16 ep16; // P16 parameter of ending event };
Copyright(c) 2002 - 2024 Sophia Cradle Incorporated All Rights Reserved. |