man ScXMLEventElt (3): implements the <event> SCXML element.

SYNOPSIS

#include <Inventor/scxml/ScXMLEventElt.h>

Inherits ScXMLExecutableElt.

Public Member Functions

virtual SoType getTypeId (void) const
Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and 'downward' casting.
virtual void setNameAttribute (const char *name)

virtual const char * getNameAttribute (void) const

virtual SbBool handleXMLAttributes (void)

virtual void copyContents (const ScXMLElt *rhs)

virtual const ScXMLElt * search (const char *attrname, const char *attrvalue) const

ScXMLEvent * createEvent (ScXMLEventTarget *host) const

virtual void execute (ScXMLStateMachine *statemachine) const

Static Public Member Functions

static ScXMLEltReader * getElementReader (void)

static SoType getClassTypeId (void)
This static method returns the SoType object associated with objects of this class.
static void * createInstance (void)

static void initClass (void)
Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
static void cleanClass (void)
Does the opposite of initClass, deallocates any class specific resources and resets the class to an uninitialized state with respect to the Coin typesystem.

Protected Attributes

char * name

Additional Inherited Members

Detailed Description

implements the <event> SCXML element.

Since:

: Coin 3.1

Member Function Documentation

SoType ScXMLEventElt::getClassTypeId (void) [static]

This static method returns the SoType object associated with objects of this class. See Also:

: SoBase::getClassTypeId

Reimplemented from ScXMLExecutableElt.

SoType ScXMLEventElt::getTypeId (void) const [virtual]

Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and 'downward' casting. See Also:

: SoBase::getTypeId() const

Implements ScXMLExecutableElt.

void ScXMLEventElt::initClass (void) [static]

Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. See Also:

: SoBase::initClass()

Reimplemented from ScXMLExecutableElt.

SbBool ScXMLEventElt::handleXMLAttributes (void) [virtual]

This method is called when the file reader has set all the XML attributes on the object, and wants the object to handle them and report if the values were ok or if a read error should be produced.

Returns:

: TRUE if the attributes are ok, and FALSE on error.

This base class implementation does nothing and just returns TRUE.

Reimplemented from ScXMLElt.

const ScXMLElt * ScXMLEventElt::search (const char attrname, const char attrvalue) const [virtual]

This method searches the SCXML structure for an element with the given attributevalue for the given attribute.

Returns NULL if nothing was found.

This function needs to be reimplemented to traverse child elements.