SFXEventRange

Class which represents an event range.

#include <SFXEventRange.h.hpp>

class SFXEventRange;

<link linkend="sec.macro.core.typedef.SFMTYPEDEFCLASS">SFMTYPEDEFCLASS</link>(SFXEventRange)

Inheritance diagram

Collaboration diagram

Description

The SFXEventRange class is a class which represents an event range, which is specified when registering an event hander for the SFY GUI framework or a tracer.

An event range is specified with each type( = event code of AEEEvent type) and each P16 parameter of starting event and ending event.

For example, SFXEventRange(SFEVT_<type_begin>, SFEVT_<type_end>, SFP16_<para_begin>, SFP16_<para_end>) represents the event between the (SFEVT_<type_begin>, SFP16_<para_begin>) event and the (SFEVT_<type_end>, SFP16_<para_end>) event.

The order relation on event codes are based on the value of BREW event code. For more details, refer to the header file SFXGeneral/SFXEvent/SFXEvent.h.hpp.

Example 812. How to use the SFXEventRange class [1] : register 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 813. How to use the SFXEventRange class [2] : register 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 814. How to use the SFXEventRange class [3] : register 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));

Reference

SFXEvent | SFCEventEnum

Member

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 to contain the specified event or event range.
`Bool`	Contains( `SFXEventConstRef` param ) Check whether or not to contain the specified event or event range.
`Bool`	Contains( `AEEEvent` stype , `AEEEvent` etype , `UInt16` sp16 , `UInt16` ep16 ) Check whether or not to contain the specified event or event range.
`Bool`	Contains( `AEEEvent` type , `UInt16` p16 ) Check whether or not to contain the specified event or event range.
`Bool`	ContainsP16( `SFXEventRangeConstRef` param ) Check whether or not to contain the P16 parameter of the specified event or event range.
`Bool`	ContainsP16( `SFXEventConstRef` param ) Check whether or not to contain the P16 parameter of the specified event or event range.
`Bool`	ContainsP16( `UInt16` sp16 , `UInt16` ep16 ) Check whether or not to contain the P16 parameter of the specified event or event range.
`Bool`	ContainsP16( `UInt16` p16 ) Check whether or not to contain the P16 parameter of the specified event or event range.
`Bool`	ContainsType( `SFXEventRangeConstRef` param ) Check whether or not to contain the type of the specified event or event range.
`Bool`	ContainsType( `SFXEventConstRef` param ) Check whether or not to contain the type of the specified event or event range.
`Bool`	ContainsType( `AEEEvent` stype , `AEEEvent` etype ) Check whether or not to contain the type of the specified event or event range.
`Bool`	ContainsType( `AEEEvent` type ) Check whether or not to contain the type of the specified event or event range.
static `SFXEventRangeConstRef`	EmptyInstance( `Void` ) Return an empty event range that contains no events.
`Bool`	Equals( `SFXEventRangeConstRef` param ) Check whether or not to equal with the specified event range.
`Bool`	Equals( `AEEEvent` stype , `AEEEvent` etype , `UInt16` sp16 , `UInt16` ep16 ) Check whether or not to equal with the specified event range.
`Bool`	EqualsP16( `SFXEventRangeConstRef` param ) Check whether or not to equal with the specified P16 parameter range.
`Bool`	EqualsP16( `UInt16` sp16 , `UInt16` ep16 ) Check whether or not to equal with the specified P16 parameter range.
`UInt16`	GetEndP16( `Void` ) Get the P16 parameter of ending event.
`AEEEvent`	GetEndType( `Void` ) Get the type of ending event.
`UInt16`	GetStartP16( `Void` ) Get the P16 parameter of starting event.
`AEEEvent`	GetStartType( `Void` ) Get the type of starting event.
`Void`	Set( `SFXEventRangeConstRef` param ) Set an event range.
`Void`	Set( `AEEEvent` stype , `AEEEvent` etype , `UInt16` sp16 , `UInt16` ep16 ) Set an event range.
`Void`	SetEndP16( `UInt16` param ) Set the P16 parameter of ending event.
`Void`	SetEndType( `AEEEvent` param ) Set the type of ending event.
`Void`	SetP16( `UInt16` sp16 , `UInt16` ep16 ) Set a P16 parameter range.
`Void`	SetStartP16( `UInt16` param ) Set the P16 parameter of starting event.
`Void`	SetStartType( `AEEEvent` param ) Set the type of starting event.
`Void`	SetType( `AEEEvent` stype , `AEEEvent` etype ) Set an event type range.
`Bool`	operator!=( `SFXEventRangeConstRef` left , `SFXEventRangeConstRef` right ) Check the "!=" relation.
`SFXEventRangeRef`	operator=( `SFXEventRangeConstRef` param ) Assign an event range.
`Bool`	operator==( `SFXEventRangeConstRef` left , `SFXEventRangeConstRef` right ) Check the "==" relation.
`Bool`	( `SFXEventRangeConstRef` param ) Check whether or not to equal with the specified event type range.
`Bool`	( `AEEEvent` stype , `AEEEvent` etype ) Check whether or not to equal with 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 to equal with the specified event type range.
`Bool`	( `AEEEvent` stype , `AEEEvent` etype ) Check whether or not to equal with 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.

SFXEventRange::SFXEventRange

Constructor of the SFXEventRange class.

[ 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
);

SFXEventRange::Contains

Check whether or not to contain the specified event or event range.

[ 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
);

Argument

param: ... param の説明 ...

Return value

If contains: true
Otherwise: false

Reference

SFXEvent | SFXEventRange::ContainsType | SFXEventRange::ContainsP16

SFXEventRange::ContainsP16

Check whether or not to contain the P16 parameter of 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
);

Return value

If contains: true
Otherwise: false

Reference

SFXEvent | SFXEventRange::Contains | SFXEventRange::ContainsType

SFXEventRange::ContainsType

Check whether or not to contain the type of the specified event or event range.

[ 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
);

Return value

If contains: true
Otherwise: false

Reference

SFXEvent | SFXEventRange::Contains | SFXEventRange::ContainsP16

SFXEventRange::EmptyInstance

Return an empty event range that contains no events.

[ public, static ]
SFXEventRangeConstRef EmptyInstance(Void);

SFXEventRange::Equals

Check whether or not to equal with the specified event range.

[ 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
);

Return value

If equals: true
Otherwise: false

Reference

SFXEventRange::operator== | SFXEvent | | SFXEventRange::EqualsP16

SFXEventRange::EqualsP16

Check whether or not to equal with the specified P16 parameter range.

[ 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
);

Return value

If equals: true
Otherwise: false

Reference

SFXEvent | | SFXEventRange::Equals

Check whether or not to equal with the specified event type 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
);

Return value

If equals: true
Otherwise: false

Reference

SFXEvent | SFXEventRange::Equals | SFXEventRange::EqualsP16

SFXEventRange::GetEndP16

Get the P16 parameter of ending event.

[ public, const ]
UInt16 GetEndP16(Void);

Return value

P16 parameter of ending event

Reference

SFXEventRange::SetEndP16 | SFXEventRange::Set | SFXEventRange::SetP16 | SFXEvent

SFXEventRange::GetEndType

Get the type of ending event.

[ public, const ]
AEEEvent GetEndType(Void);

Return value

type of ending event

Reference

SFXEventRange::SetEndType | SFXEventRange::Set | SFXEventRange::SetType | SFXEvent

SFXEventRange::GetStartP16

Get the P16 parameter of starting event.

[ public, const ]
UInt16 GetStartP16(Void);

Return value

P16 parameter of starting event

Reference

SFXEventRange::SetStartP16 | SFXEventRange::Set | SFXEvent

SFXEventRange::GetStartType

Get the type of starting event.

[ public, const ]
AEEEvent GetStartType(Void);

Return value

type of starting event

Reference

SFXEventRange::SetStartType | SFXEventRange::Set | SFXEvent

SFXEventRange::Set

Set an event range.

[ public ]
Void Set(
    SFXEventRangeConstRef param   // event range
);

[ public ]
Void Set(
    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
);

Reference

SFXEventRange::SetEndP16

Set the P16 parameter of ending event.

[ public ]
Void SetEndP16(
    UInt16 param   // P16 parameter of ending event
);

Reference

SFXEventRange::GetEndP16 | SFXEventRange::Set | SFXEventRange::SetP16 | SFXEvent

SFXEventRange::SetEndType

Set the type of ending event.

[ public ]
Void SetEndType(
    AEEEvent param   // type of ending event
);

Reference

SFXEventRange::GetEndType | SFXEventRange::Set | SFXEventRange::SetType | SFXEvent

SFXEventRange::SetP16

Set a P16 parameter range.

[ public ]
Void SetP16(
    UInt16 sp16   // P16 parameter of starting event
    UInt16 ep16   // P16 parameter of ending event
);

Reference

SFXEventRange::SetStartP16

Set the P16 parameter of starting event.

[ public ]
Void SetStartP16(
    UInt16 param   // P16 parameter of starting event
);

Reference

SFXEventRange::GetStartP16 | SFXEventRange::Set | SFXEvent

SFXEventRange::SetStartType

Set the type of starting event.

[ public ]
Void SetStartType(
    AEEEvent param   // type of starting event
);

Reference

SFXEventRange::GetStartType | SFXEventRange::Set | SFXEvent

SFXEventRange::SetType

Set an event type range.

[ public ]
Void SetType(
    AEEEvent stype   // type of starting event
    AEEEvent etype   // type of ending event
);

Reference

atomic_cast

Convert SFXEventRange into SFXEventRange::AtomRec.

[ 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
);

Reference

SFXRectangle::AtomRec

SFXEventRange::operator=

Assign an event range.

[ public ]
SFXEventRangeRef operator=(
    SFXEventRangeConstRef param   // event range
);

Reference

SFXEventRange::Set | SFXEvent

SFXEventRange::operator==

Check the "==" relation.

[ public, friend ]
Bool operator==(
    SFXEventRangeConstRef left    // event range to be compared
    SFXEventRangeConstRef right   // event range to compare with
);

Return value

If equals: true
Otherwise: false

Reference

SFXEventRange::operator!= | SFXEvent | SFXEventRange::Equals

SFXEventRange::operator!=

Check the "!=" relation.

[ public, friend ]
Bool operator!=(
    SFXEventRangeConstRef left    // evant range to be compared
    SFXEventRangeConstRef right   // event range to compare with
);

Return value

If not equal: true
Otherwise: false

Reference

SFXEventRange::operator!= | SFXEvent | SFXEventRange::Equals

SFXRectangle::AtomRec

The SFXEventRange::AtomRec struct represents an event range.

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
};